Automate the release process with a GitHub Actions workflow #514
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To make it easy to make releases, automate the process via GitHub
Actions.
Create a workflow that:
1. Runs cargo publish
2. Pushes a git tag,
but only if the publish was successful.
3. Creates a GitHub Release with release notes from CHANGELOG.md,
but only if creating the tag was successful.
|
@trishume Friendly one-month ping. Collaborators can't access repo secrets, so you are the only one that can add one. Doing the steps above shouldn't take many minutes. If you are uncomfortable with storing the secret on GitHub, I could make it a one-time masked input secret that is inputted each run, if you prefer. That way no secrets are stored anywhere. But the risk of the secret leaking by GitHub is low (I have never heard of it happening), and if it happens it is not a super big deal, since it can't be used to remove us as owners from crates.io. |
|
Closing in favor of #517 that does not require storing secrets on GitHub. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To make it easy to make releases (and we need a release to unblock sharkdp/bat#2815), automate the process via GitHub Actions.
Create a workflow that:
I've been using a variant of this workflow for my own projects for quite a while now, and find that it works well.
New release process
After this lands, this will be the new release process:
Help needed to setup
Hi @trishume ! Would be great if you could help set up an automated release process. I only need your help with this:
Create a crates.io token
syntect.If you prefer me to use a token belonging to my account, that's perfectly fine with me, just let me know. I'll then share it with you through gpg.
Create a GitHub Actions secret
crates.ioCARGO_REGISTRY_TOKENand paste the above tokenDone! Once that is done (which only you can do) I will release syntect 5.2.0 using the new process. I have confirmed that this process works with the changelog format of syntect by verifying with a toy project of mine.